.codespellrc: document each skip pattern and whitelisted word#7463
Merged
Conversation
Switch ignore-words-list from a single comma-separated line to the multi-line config-file form so each entry can be preceded by a one-line rationale (Go variable abbreviation, library name, test-fixture string, truncated CHANGELOG title, etc.). This makes future reviewers able to sanity-check additions without grepping the codebase for the term. Also add an explanatory comment block above `skip` documenting why each pattern is skipped. No behavior change: `codespell` still passes with zero errors. Signed-off-by: Yaroslav Halchenko <yaroslav.o.halchenko@dartmouth.edu> Co-Authored-By: Claude Code 2.1.157 / Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
pingsutw
approved these changes
Jun 1, 2026
Member
|
@yarikoptic thank you |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why are the changes needed?
.codespellrc'signore-words-listhad grown to 9 short, opaque entries(
astroid,bootup,decorder,fo,lightyear,nd,notin,ser,te). Readers andreviewers cannot tell at a glance why each is whitelisted, which makes it
hard to audit additions or remove dead entries over time.
What changes were proposed in this pull request?
Switch
ignore-words-listto the multi-line config-file form so eachentry can be preceded by a one-line rationale (Go variable abbreviation,
library name, test-fixture string, etc.). Same pattern as
restic/restic#21807.
Also annotate the
skippatterns inline.No behavior change: same words skipped/whitelisted, just documented.
How was this patch tested?
uvx codespellpasses with zero errors after the reformat. Each entrywas also verified to be still needed (removing any one of them causes
codespell to flag a real occurrence in the tree).
Labels
Check all the applicable boxes
feel welcome to just close since I am not sure if worth it and not sure what is difference between main and master